home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audio / alDiscardFrames.z / alDiscardFrames
Encoding:
Text File  |  2002-10-03  |  4.0 KB  |  67 lines
  1.  
  2.  
  3.  
  4. aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm))))                                      aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alDiscardFrames - discard audio from an audio port
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      iiiinnnntttt aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt,,,, iiiinnnntttt ffffrrrraaaammmmeeeeccccoooouuuunnnntttt))))
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  17.      _p_o_r_t         is the audio port from which you want to discard samples.
  18.                   This is the returned value of an aaaallllOOOOppppeeeennnnPPPPoooorrrrtttt((((3333ddddmmmm)))) call.
  19.  
  20.      _f_r_a_m_e_c_o_u_n_t   expects the number of sample frames that you wish to
  21.                   discard.
  22.  
  23. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.      aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss removes samples from an input or output audio port and
  25.      throws them away. Its behavior differs slightly between input and output
  26.      ports.
  27.  
  28.      For an input port, aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss discards an arbitrary number of sample
  29.      frames. If the given _f_r_a_m_e_c_o_u_n_t exceeds the number of audio sample frames
  30.      in the port, aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss will block until the given number of frames
  31.      have been discarded. It is thus functionally equivalent to calling
  32.      aaaallllRRRReeeeaaaaddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) and discarding the data, except that aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss is
  33.      simpler and more efficient.
  34.  
  35.      For an output port, aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss discards at most as many sample
  36.      frames as are in the port, and returns immediately.
  37.  
  38.      In either case, the samples are discarded from the end of the audio queue
  39.      closest to the application: on input, the next samples to be read are
  40.      discarded; on output, the most recent samples written are discarded.
  41.  
  42. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  43.      Upon successful completion, aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss returns the number of frames
  44.      discarded. Otherwise, it returns -1 and sets an error number which can be
  45.      retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  46.  
  47.      aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss can fail for the following reasons:
  48.  
  49.      AAAALLLL____BBBBAAAADDDD____PPPPOOOORRRRTTTT            _p_o_r_t is invalid.
  50.  
  51.      AAAALLLL____BBBBAAAADDDD____FFFFIIIILLLLLLLLPPPPOOOOIIIINNNNTTTT       _f_r_a_m_e_c_o_u_n_t is less than zero.
  52.  
  53. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  54.      alOpenPort(3dm), alReadFrames(3dm), oserror(3C)
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.